Skip to content

chore: use rumdl for Markdown formatting#9

Merged
henryiii merged 1 commit into
mainfrom
rumdl-migration
Jul 1, 2026
Merged

chore: use rumdl for Markdown formatting#9
henryiii merged 1 commit into
mainfrom
rumdl-migration

Conversation

@henryiii

@henryiii henryiii commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

🤖 AI text below 🤖

Move Markdown formatting from prettier to rumdl.

What changed

  • .pre-commit-config.yaml — added the rumdl-fmt hook (rumdl-pre-commit v0.2.27); prettier stays but now excludes \.md$, so rumdl owns Markdown and prettier keeps CSS / JSON / YAML.
  • .rumdl.toml (new) — content/**/*.md uses the myst flavor (directive/role aware); slides/ stays standard Markdown (Marp). Disabled MD013 (line length), MD033 (inline HTML — Marp <div class="columns">), MD026 (intentional trailing : in slide headings), and MD076 (false-positive on a mixed-indent :::{card}).
  • DocsAGENTS.md / CLAUDE.md list rumdl alongside prettier.

Formatting the switch applied

  • content/basic-packaging/01_setup.md — blank lines added around MyST directives (MD031, myst-flavor aware).
  • README.md — bare URL wrapped in <…> (MD034).
  • slides/1_01_setup.mdtext language added to a fenced block (MD040).

Verification

  • bun run build — book + slides build with no directive warnings.
  • prek -a — full suite green (rumdl fmt and prettier both pass).

Move Markdown formatting from prettier to rumdl (mystmd flavor for
content/, standard for the Marp slides/). prettier stays for the
non-Markdown files (CSS, JSON, YAML) via an `\.md$` exclude.

rumdl fmt's directive-aware fixes (MD031) add blank lines around MyST
directives; MD013/MD033/MD026/MD076 are disabled as they don't fit
prose/slide content.

Assisted-by: ClaudeCode:claude-opus-4.8
@henryiii henryiii merged commit d32d4e8 into main Jul 1, 2026
2 checks passed
@henryiii henryiii changed the title ci: use rumdl for Markdown formatting chore: use rumdl for Markdown formatting Jul 1, 2026
@henryiii henryiii mentioned this pull request Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant